<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Clean up snapshot repository API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'clean-up-snapshot-repo-api.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/clean-up-snapshot-repo-api.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/clean-up-snapshot-repo-api.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/clean-up-snapshot-repo-api.html" rel="nofollow" target="_blank">../en/clean-up-snapshot-repo-api.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="snapshot-restore-apis.html">Snapshot and restore APIs</a></span>
»
<span class="breadcrumb-node">Clean up snapshot repository API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="snapshot-restore-apis.html">« Snapshot and restore APIs</a>
</span>
<span class="next">
<a href="delete-snapshot-repo-api.html">Delete snapshot repository API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="clean-up-snapshot-repo-api"></a>Clean up snapshot repository API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Triggers the review of a snapshot repository’s contents and deletes any stale
data that is not referenced by existing snapshots.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST /_snapshot/my_repository/_cleanup</pre>
</div>
<div class="console_widget" data-snippet="snippets/2135.console"></div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clean-up-snapshot-repo-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">POST /_snapshot/&lt;repository&gt;/_cleanup</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clean-up-snapshot-repo-api-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc">edit</a>
</h3>
</div></div></div>
<p>Over time, snapshot repositories can accumulate stale data that is no longer
referenced by existing snapshots.</p>
<p>While this unreferenced data does not negatively impact the performance or
safety of a snapshot repository, it can lead to more storage use than necessary.</p>
<p>You can use the clean up snapshot repository API to detect and delete this
unreferenced data.</p>
<div class="tip admon">
<div class="icon"></div>
<div class="admon_content">
<p>Most cleanup operations performed by this API are performed automatically when
a snapshot is deleted from a repository.</p>
<p>If you regularly delete snapshots, calling this API may only reduce your storage
slightly or not at all.</p>
</div>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clean-up-snapshot-repo-api-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;repository&gt;</code>
</span>
</dt>
<dd>
(Required, string)
Name of the snapshot repository to review and clean up.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clean-up-snapshot-repo-api-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">master_timeout</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to <code class="literal">30s</code>.
</dd>
<dt>
<span class="term">
<code class="literal">timeout</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>) Specifies the period of time to wait for
a response. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to <code class="literal">30s</code>.
</dd>
</dl>
</div>
</div>

<div class="section child_attributes">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clean-up-snapshot-repo-api-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">results</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics for cleanup operations.
</p>
<details open>
<summary class="title">Properties of <code class="literal">results</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">deleted_bytes</code>
</span>
</dt>
<dd>
(integer)
Number of bytes freed by cleanup operations.
</dd>
<dt>
<span class="term">
<code class="literal">deleted_blobs</code>
</span>
</dt>
<dd>
(integer)
Number of binary large objects (blobs) removed from the snapshot repository
during cleanup operations. Any non-zero value implies that unreferenced blobs
were found and subsequently cleaned up.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="clean-up-snapshot-repo-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/snapshot-restore/apis/clean-up-repo-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST /_snapshot/my_repository/_cleanup</pre>
</div>
<div class="console_widget" data-snippet="snippets/2136.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
  "results": {
    "deleted_bytes": 20,
    "deleted_blobs": 5
  }
}</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="snapshot-restore-apis.html">« Snapshot and restore APIs</a>
</span>
<span class="next">
<a href="delete-snapshot-repo-api.html">Delete snapshot repository API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>